revelplayer/com.reveldigital.player.api/[androidJvm]File

File

interface File

Represents a file managed or utilized by the RevelDigital player.

This interface provides access to metadata and, where applicable, the content of various types of files, such as media assets (images, videos), gadget definitions, or other resources used in digital signage presentations.

Instances of this interface might be obtained when querying content libraries, accessing details of currently playing media, or interacting with downloaded assets. The specific data available can vary depending on the file's type and origin.

See also

// Ensure Gadget interface/class is also well-documented

Functions

Link copied to clipboard
@Nullable
abstract fun getDescription(): String
Gets a user-provided description or caption for the file.
Link copied to clipboard
abstract fun getFileSize(): Int
Gets the size of the file.
Link copied to clipboard
@Nullable
abstract fun getGadget(): Gadget
Gets the Gadget definition if this file represents a RevelDigital gadget.
Link copied to clipboard
@Nullable
abstract fun getMediaFile(): File
Gets a java.io.File object representing the local filesystem path to the actual file data, if available.
Link copied to clipboard
abstract fun getMimeType(): String
Gets the MIME type of the file, indicating its format and nature.
Link copied to clipboard
abstract fun getName(): String
Gets the display name of the file.